Skip to content

SK-3289: address Detect docs and sample parity feedback (Python) - #290

Open
saileshwar-skyflow wants to merge 1 commit into
flowvault-release/26.10.0from
saileshwar/SK-3289-address-parity-gap
Open

saileshwar-skyflow wants to merge 1 commit into
flowvault-release/26.10.0from
saileshwar/SK-3289-address-parity-gap

Conversation

@saileshwar-skyflow

Copy link
Copy Markdown
Collaborator

What

Addresses the final Detect feedback (docs + samples parity) for the Python SDKs — the items under Python (FlowVault) and Python (SkyVault), plus the shared nomenclature points. Docs/samples only; no SDK source changes.

flowvault README

  • Remove the unsupported SKYFLOW_ID file source and state plainly that flowvault's DeidentifySourceType is BASE64/PRESIGNED_URL only (previously a copy-paste AttributeError).
  • Document include_prefix / prefix_override on Entity and CustomType (incl. the include_prefix=NO "not re-identifiable" trap), and deidentification_type / destination on CustomType.
  • Add where-to-create pointers (Studio / management API) for the configuration id, token groups and redaction patterns in Before you start.
  • Add a Response examples and common errors section (sample JSON per shape + the common 400s).
  • Make the re-identify example a round trip with a real vault token; branch re-identify-file on output_type (was an unconditional base64 decode + hardcoded .txt).

skyvault README

  • Same re-identify round-trip fix (storing tokens in a table.column) and output_type branch.
  • Add a bold warning that deidentify_file no longer waits by default.
  • Note the server's default toxicity check; fix the stale v1 EOL banner (will reach → reached).

Samples (both SDKs)

  • Print request_id in every Detect error handler.

Nomenclature

  • Drop the "Detect V2" label from both READMEs and the flowvault samples README.
  • Rename the migration guide to docs/migrate_detect.md, retitle it ("Migrate to the new Detect methods (skyflow 3.0.0)"), cite skyflow 3.0.0 in the intro + timeline, and promote the deidentify_file behaviour change to a top-of-doc warning.

Notes / decisions

  • setup.py version is managed by release automation and is left unchanged; the guide now names 3.0.0 as the target — please confirm that's the release version.
  • The guide's detailed method/field mapping tables still use "V1/V2" column labels (standard for a migration mapping, same as the Go guide); the customer-facing framing (title, intro, timeline) drops the V1/V2 nomenclature. Happy to scrub the body fully if preferred.

Verification

  • All 12 Detect sample files compile (py_compile).
  • No remaining Detect V2 / V2 API strings in the touched docs; no SKYFLOW_ID left in the flowvault README.

🤖 Generated with Claude Code

Fix the Detect README and sample gaps raised in the final Detect feedback, for
both the flowvault and skyvault Python SDKs.

flowvault README:
- drop the unsupported SKYFLOW_ID file source (the enum is BASE64/PRESIGNED_URL only)
- document Entity/CustomType include_prefix and prefix_override, and CustomType
  deidentification_type and destination
- add where-to-create pointers for the configuration id, token groups and redaction patterns
- add response examples and a common-errors section
- make the re-identify example a round trip; branch re-identify file on output_type

skyvault README:
- make the re-identify example a round trip that stores tokens in a table.column;
  branch re-identify file on output_type
- add a bold warning that deidentify_file no longer waits by default
- note the server's default toxicity check; fix the stale v1 EOL banner

samples (both SDKs): print request_id in Detect error handlers.

Nomenclature: drop the "Detect V2" label from both READMEs and the samples README;
rename the migration guide to docs/migrate_detect.md, retitle it, cite skyflow 3.0.0,
and promote the deidentify_file behaviour change.

setup.py version is managed by release automation and left unchanged; the guide now
names 3.0.0 as the target.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@promptless

promptless Bot commented Nov 9, 2026

Copy link
Copy Markdown

Promptless documentation updates

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants